/*
    Carracci Systems - Carracci Server (openbam project)
    Copyright (C) 2007  Carracci Systems

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

package org.openbam.core.expr;

import org.openbam.core.Event;

import java.util.List;

/**
 * Defines an operating window that is used by aggregate functions to restrict
 * the number of events they are applying their algorithm on.
 *
 * @author inder.sabharwal
 */
public interface IOperatingWindow {

    /**
     * Resize the current operating window based on a new event.
     *
     * @param newEvent
     * @param resizeHandler - invoked for each EvaluatedValue that is removed
     *                      from the operating window.
     */
    void resizeWindow(Event newEvent, IOnResizeHandler resizeHandler);

    /**
     * Get the current window.
     *
     * @return
     */
    List<EvaluatedValue> getCurrentWindow();

    void addEvaluatedValue(EvaluatedValue eval);

}
